API endpoints

Local space heaters

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Local space heaters: arrow image

Path

/api/v1/local-space-heaters/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
efficiencyRating	The energy efficiency class of the model. Must be one of: A++ A+ A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "efficiencyRating": "A++" }

Local space heaters: energy label

You must attach the label to the front or top of the product so that it’s easy to see. It must be at least 105mm x 200mm when printed.

Path

/api/v1/local-space-heaters/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	The energy efficiency class of the model. Must be one of: A++ A+ A B C D E F G	String
directHeatOutput	The direct heat output in kW. This may be up to 2 digits long with an optional 1 decimal place.	Number
fluidTransfer	Is this model a local space heater with transfer to a fluid?	Boolean
indirectHeatOutput	The indirect heat output in kW. Only required if fluidTransfer is true. This may be up to 2 digits long with an optional 1 decimal place.	Number

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A++", "directHeatOutput": 1.1, "fluidTransfer": true, "indirectHeatOutput": 1.1 }